Webcom Android API/com.orange.webcom.sdk

Package com.orange.webcom.sdk

Exposes the main public API of the Webcom SDK.

Types

data class Canceled : Notification.ControlNotification, Notifiable

Generic event to be notified when a subscription is canceled, that is deliberately stopped.

interface Notification<out T : Notifiable>

Base interface for passing an event of type T to a callback function.

interface Subscription

Represents a subscription to some event type.

object Webcom

WebcomApplication

class WebcomApplication

Represents a Webcom application.

WebcomConfiguration

data class WebcomConfiguration @JvmOverloads constructor( val identifier: String, val platform: URL? = null, val offlineCache: String? = null, val startOnline: Boolean = true, val websocketProtocol: WebcomConfiguration.WebsocketProtocol = defaultWebsocketProtocol, val pingDelayMs: Int? = null, val pongDelayMs: Int? = null)

Represents the settings of a WebcomApplication instance.

class WebcomError @JvmOverloads constructor( val errorCode: String, message: String?, cause: Throwable? = null)

WebcomException

class WebcomException(fromError: WebcomError?) : Exception

sealed class WebcomResult<out T>

Wraps the result of a computation of type T.

WebcomRuntimeException

class WebcomRuntimeException(message: String?) : RuntimeException